CimAlarm Json Schema

In This Topic

Description

object provides an interface to CIMPLICITY Alarm configuration

Overview

CimAlarm

object provides an interface to CIMPLICITY Alarm configuration

AckTimeout : integer

is a long integer that indicates when automatic alarm acknowledgement should happen. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm

AlarmClass : string

is a string containing the class of the alarm

AlarmDescription : string

is a string containing the description of the alarm, This attribute shall be ignored in case of point alarm

AlarmID : string

is a string containing the Alarm ID. When accessed from a Point Alarm, this property is read-only because the Alarm ID is the same as the Point ID

AlarmMessage : string

is a string containing the alarm message. Note When accessed from a Point Alarm, this property is read-only because the structure of the point alarm message defines the alarm message

AlarmTypeID : string

is a string containing the alarm type id of the alarm. When accessed from a Point Alarm, this property is read-only because the structure of the point alarm message defines the Alarm Type Id

Changeapproval : CimChangeapprovalEnum

defines different change approval data setting. The numeric value of these enumerations can be used in an expression of a class data item for the $APPROVAL_TYPE field

DeleteOpt : CimAlarmDelOptEnum

defines the deletion options available for an alarm

HelpFileName : string

is a string containing the name of the alarm help file. The string must be prefixed with AM_HELP:\ in order for the file to be found by the alarm viewer and must have the extension HLP.

HiAckTimeout : integer

The CimAlarm.HiAckTimeout is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Warning High state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm

HiDeleteOpt : CimAlarmDelOptEnum

defines the deletion options available for an alarm

HiHiAckTimeout : integer

The CimAlarm.HiHiAckTimeout is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Alarm High state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm

HiHiDeleteOpt : CimAlarmDelOptEnum

defines the deletion options available for an alarm

HiHiLogOpt : string

The CimAlarm.HiHiLogOpt is a string that indicates what the alarm transitions in the Alarm High state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated

HiHiRepeatTimeout : integer

is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Alarm High state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm

HiHiResetAllowed : boolean

is a boolean that indicates if the alarm can be manually reset when it is in the Alarm High state

HiHiResetTimeout : integer

The CimAlarm.HiHiResetTimeout is a long integer that indicates when automatic alarm reset should happen while the alarm in the Alarm High state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm

HiLogOpt : string

The CimAlarm.HiLogOpt is a string that indicates what the alarm transitions in the Warning High state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated

HiRepeatTimeout : integer

is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Warning High state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm

HiResetAllowed : boolean

is a boolean that indicates if the alarm can be manually reset when it is in the Warning High state

HiResetTimeout : integer

The CimAlarm.HiResetTimeout is a long integer that indicates when automatic alarm reset should happen while the alarm in the Warning High state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm

LoAckTimeout : integer

is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Warning Low state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm.

LoDeleteOpt : CimAlarmDelOptEnum

defines the deletion options available for an alarm

LoLoAckTimeout : integer

is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Alarm Low state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm

LoLoDeleteOpt : CimAlarmDelOptEnum

defines the deletion options available for an alarm

LoLoLogOpt : string

is a string that indicates what the alarm transitions in the Alarm Low state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated

LoLoRepeatTimeout : integer

is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Alarm Low state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm

LoLoResetAllowed : boolean

is a boolean that indicates if the alarm can be manually reset when it is in the Alarm Low state

LoLoResetTimeout : integer

The CimAlarm.LoLoResetTimeout is a long integer that indicates when automatic alarm reset should happen while the alarm in the Alarm Low state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm

LoLogOpt : string

The CimAlarm.LoLogOpt is a string that indicates what the alarm transitions in the Warning Low state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated

LoRepeatTimeout : integer

is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Warning Low state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm

LoResetAllowed : boolean

is a boolean that indicates if the alarm can be manually reset when it is in the Warning Low state

LoResetTimeout : integer

is a long integer that indicates when automatic alarm reset should happen while the alarm in the Warning Low state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm

LogOpt : string

The CimAlarm.LogOpt is a string that indicates when the alarm should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated

MaxStacked : integer

is a long integer that indicates how many alarms to stack. Defaults to zero if not specified. Maximum value is 20

Published : boolean

is a boolean used to enable or disable publishing to SOA for an alarm. Defaults to FALSE for a new alarm

RepeatTimeout : integer

is a long integer that indicates when automatic alarm repeat should occur 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm

ResetAllowed : boolean

is a boolean that indicates if the alarm can be manually reset

ResetTimeout : integer

The CimAlarm.ResetTimeout is a long integer that indicates when automatic alarm reset should happen. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm

Routing : Array[string]

returns an object containing the alarm routing for the alarm

Severity : integer

is a short that indicates the alarm severity

Properties

Name	Description	Data Type
AckTimeout	is a long integer that indicates when automatic alarm acknowledgement should happen. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm	integer
AlarmClass	is a string containing the class of the alarm	string
AlarmDescription	is a string containing the description of the alarm, This attribute shall be ignored in case of point alarm	string
AlarmID	is a string containing the Alarm ID. When accessed from a Point Alarm, this property is read-only because the Alarm ID is the same as the Point ID	string
AlarmMessage	is a string containing the alarm message. Note When accessed from a Point Alarm, this property is read-only because the structure of the point alarm message defines the alarm message	string
AlarmTypeID	is a string containing the alarm type id of the alarm. When accessed from a Point Alarm, this property is read-only because the structure of the point alarm message defines the Alarm Type Id	string
Changeapproval	defines different change approval data setting. The numeric value of these enumerations can be used in an expression of a class data item for the $APPROVAL_TYPE field	CimChangeapprovalEnum
DeleteOpt	defines the deletion options available for an alarm	CimAlarmDelOptEnum
HelpFileName	is a string containing the name of the alarm help file. The string must be prefixed with AM_HELP:\ in order for the file to be found by the alarm viewer and must have the extension HLP.	string
HiAckTimeout	The CimAlarm.HiAckTimeout is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Warning High state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm	integer
HiDeleteOpt	defines the deletion options available for an alarm	CimAlarmDelOptEnum
HiHiAckTimeout	The CimAlarm.HiHiAckTimeout is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Alarm High state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm	integer
HiHiDeleteOpt	defines the deletion options available for an alarm	CimAlarmDelOptEnum
HiHiLogOpt	The CimAlarm.HiHiLogOpt is a string that indicates what the alarm transitions in the Alarm High state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated	string
HiHiRepeatTimeout	is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Alarm High state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm	integer
HiHiResetAllowed	is a boolean that indicates if the alarm can be manually reset when it is in the Alarm High state	boolean
HiHiResetTimeout	The CimAlarm.HiHiResetTimeout is a long integer that indicates when automatic alarm reset should happen while the alarm in the Alarm High state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm	integer
HiLogOpt	The CimAlarm.HiLogOpt is a string that indicates what the alarm transitions in the Warning High state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated	string
HiRepeatTimeout	is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Warning High state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm	integer
HiResetAllowed	is a boolean that indicates if the alarm can be manually reset when it is in the Warning High state	boolean
HiResetTimeout	The CimAlarm.HiResetTimeout is a long integer that indicates when automatic alarm reset should happen while the alarm in the Warning High state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm	integer
LoAckTimeout	is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Warning Low state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm.	integer
LoDeleteOpt	defines the deletion options available for an alarm	CimAlarmDelOptEnum
LoLoAckTimeout	is a long integer that indicates when automatic alarm acknowledgement should happen while the alarm in the Alarm Low state. Valid values are -1 - Immediate Acknowledgement 0 - No Automatic Acknowledgement (default) >0 - Number of minutes to wait before automatically acknowledging alarm	integer
LoLoDeleteOpt	defines the deletion options available for an alarm	CimAlarmDelOptEnum
LoLoLogOpt	is a string that indicates what the alarm transitions in the Alarm Low state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated	string
LoLoRepeatTimeout	is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Alarm Low state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm	integer
LoLoResetAllowed	is a boolean that indicates if the alarm can be manually reset when it is in the Alarm Low state	boolean
LoLoResetTimeout	The CimAlarm.LoLoResetTimeout is a long integer that indicates when automatic alarm reset should happen while the alarm in the Alarm Low state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm	integer
LoLogOpt	The CimAlarm.LoLogOpt is a string that indicates what the alarm transitions in the Warning Low state should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated	string
LoRepeatTimeout	is a long integer that indicates when automatic alarm repeat should occur while the alarm is in the Warning Low state. 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm	integer
LoResetAllowed	is a boolean that indicates if the alarm can be manually reset when it is in the Warning Low state	boolean
LoResetTimeout	is a long integer that indicates when automatic alarm reset should happen while the alarm in the Warning Low state. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm	integer
LogOpt	The CimAlarm.LogOpt is a string that indicates when the alarm should be logged. Valid characters are A - Log when acknowledged R - Log when reset D - Log when deleted G - Log when generated	string
MaxStacked	is a long integer that indicates how many alarms to stack. Defaults to zero if not specified. Maximum value is 20	integer
Published	is a boolean used to enable or disable publishing to SOA for an alarm. Defaults to FALSE for a new alarm	boolean
RepeatTimeout	is a long integer that indicates when automatic alarm repeat should occur 0 - No Automatic Repeat (default) >0 - Number of minutes to wait before automatically repeating alarm	integer
ResetAllowed	is a boolean that indicates if the alarm can be manually reset	boolean
ResetTimeout	The CimAlarm.ResetTimeout is a long integer that indicates when automatic alarm reset should happen. Valid values are -1 - Immediate reset 0 - No Automatic reset (default) >0 - Number of minutes to wait before automatically resetting alarm	integer
Routing	returns an object containing the alarm routing for the alarm	Array[string]
Severity	is a short that indicates the alarm severity	integer